home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / util / misc / MJDiary.lha / Diary.doc next >
Encoding:
Text File  |  1995-02-11  |  4.5 KB  |  138 lines
  1.  
  2.                    MJSoft's Diary -- Simple Reminder Utility
  3.  
  4.                  (c) 1992 Martin Mares, MJSoft System Software
  5.  
  6. ================================================================================
  7.  
  8.  
  9. Preface
  10. =======
  11.  
  12.    Diary 1.0 and its documentation are Copyright (c) Martin Mares, MJSoft System
  13. Software, Prague, Czech Republic.
  14.  
  15.    This  archive  can  be  freely  redistributed as long as all of its files are
  16. included   in   their   original   form  without  any  additions,  deletions  or
  17. modifications  (excluding addition of other README-style files and icons) and no
  18. more  than a nominal fee is charged for its distribution.  All copyright notices
  19. in  the  programs and accompanying documentation files must remain intact.  It's
  20. especially  forbidden  to add various '.displayme' files and BBS advertisements.
  21. This style of distribution is generally known as FREEWARE.
  22.  
  23.    Special  permission is given to Fred Fish to distribute this program on his
  24. "Fish Disks".
  25.  
  26.    This  software  is  provided  "AS  IS"  without  warranty of any kind, either
  27. expressed  or  implied.   The author is not responsible for any damage caused by
  28. it.
  29.  
  30.  
  31. Introduction
  32. ============
  33.  
  34.    Diary is a very old utility designed by me in 1992 for the 1.3 Kickstart
  35. and arp.library. It has slightly cryptic configuration file and only few
  36. features, but these features were always the only things I needed from it.
  37. Today, I decided to write documentation and release it, although it seems
  38. to be slightly out-of-date.
  39.  
  40.    Have you ever missed somebody's birthday or other anniversary? I have many
  41. times... until I wrote this utility. It examines a list of actions stored in
  42. configuration file and displays those which are in near future (exact meaning
  43. of `near future' is given as an argument in days). It's also capable of
  44. calculating how many years passed after something (somebody's birth etc.)
  45. happened.
  46.  
  47.    It's useful to include Diary in the Startup-sequence, but I wanted it to be
  48. started only when the date has changed since last boot -- in this case, you need
  49. the EveryDay utility.
  50.  
  51. Example installation:
  52.  
  53. :Asm/Load/EveryDay
  54. if warn
  55.   diary 14
  56. endif
  57.  
  58.  
  59. Requirements
  60. ============
  61.  
  62.    - Kickstart 1.2 or newer
  63.  
  64.    - arp.library (_real_ arp library, no fake 2.0+ version)
  65.  
  66.  
  67. Command-line invocation
  68. =======================
  69.  
  70.    Diary has only one optional parameter called DAYS. It specifies how many days
  71. to the future shall Diary look when searching for events (default=0 -- examine
  72. only events happening today).
  73.  
  74.  
  75. Configuration file
  76. ==================
  77.  
  78.    The calendar data needed by Diary are contained in S:Diary.dat. This file is
  79. an usual ASCII text file -- each line corresponds to one event. Empty lines and
  80. lines beginning with '#' are silently ignored. The other lines have the
  81. following form:
  82.  
  83. DD-MM-YY text
  84.  
  85.    or
  86.  
  87. DD-MM-YYF text
  88.  
  89.    where DD specifies day, MM month, YY last two digits of year when has the
  90. event to be reported. You may use '?' instead of each digit you want to be
  91. ignored.
  92.  
  93.    <text> is the text you want to display. If you include '(QQ)' in the text
  94. (where QQ are last two digits of year), Diary will substitute the QQ by
  95. number of years between the given year (QQ) and current year -- if you use
  96. year of someone's birth, Diary will write how old is the person now.
  97.  
  98.    You may specify a single letter F containing time restriction. This letter
  99. specifies how many days in the future the event should be reported (it works
  100. _in_conjunction_ with the command-line argument -- the DAYS argument is _not_
  101. overriden by it). 'A' means ony today, 'B' today and tomorrow, ..., 'Z' means
  102. today and next 25 days.
  103.  
  104.    Let's have a look on the following example of config file:
  105.  
  106. 13-12-??A Beware of werewolves
  107. 15-12-?? Alice's birthday (72)
  108. ??-??-?? Whereever you go, there you are.
  109. 31-11-00 Happens rarely
  110. 12-12-95C The Christmas is very near!
  111.  
  112.    On the 10th December 1995, you will get (assuming DAYS=10):
  113.  
  114. Today is Sunday, 10-12-95.
  115.  
  116. 10-12-95: Whereever you go, there you are.
  117. 11-12-95: Whereever you go, there you are.
  118. 12-12-95: Whereever you go, there you are.
  119. 12-12-95: The Christmas is very near!
  120. 13-12-95: Whereever you go, there you are.
  121. 14-12-95: Whereever you go, there you are.
  122. 15-12-95: Alice's birthday (23)
  123. 15-12-95: Whereever you go, there you are.
  124. 16-12-95: Whereever you go, there you are.
  125. 17-12-95: Whereever you go, there you are.
  126. 18-12-95: Whereever you go, there you are.
  127. 19-12-95: Whereever you go, there you are.
  128. 20-12-95: Whereever you go, there you are.
  129.  
  130.    I think it's sufficient.
  131.  
  132.  
  133. Notes
  134. =====
  135.  
  136.    Send comments, suggestions and bug reports to mjsoft@k332.feld.cvut.cz
  137.  
  138.